Get Services Brief Details (V3)

The Get Services Brief Details (V3) request retrieves a list of existing customers for the Live Platform instance including all license types.

URI

Copy 
{{baseUrl}}/api/v3/customer

HTTP Method

GET

Request Parameters

Attribute

Type

Description

allDetails

boolean

Default: false

When enabled retrieves the Site Locations array (SIP Connections) for all customers.

Example Response

Example of a response for a request without allDetails or allDetails=false (api/v3/customer?allDetails=false) in query string:

Copy 
[
  {
    "UmpCustomerGuid": "1591f338-58f8-4773-a625-0079f1565341",
    "CustomerShortName": "micu_test",
    "CustomerFullName": "micu_test",
    "LicenseType": 0,
    "LicensedUsersCount": null,
    "MsTenantId": null,
    "ActiveUserCount": 0,
    "LiveHubActiveUsersCount": null,
    "LiveHubSimpleUsersCount": null
  },
  {
    "UmpCustomerGuid": "0c8e0080-8bf3-4ae4-8b96-219977ae508f",
    "CustomerShortName": "auto_serv_ess",
    "CustomerFullName": "auto_serv_ess",
    "LicenseType": 0,
    "LicensedUsersCount": null,
    "MsTenantId": null,
    "ActiveUserCount": 0,
    "LiveHubActiveUsersCount": null,
    "LiveHubSimpleUsersCount": null
  },
  {
    "UmpCustomerGuid": "2373394e-7b5f-40cc-907b-29a4f70e7859",
    "CustomerShortName": "auto_sys_plus_r",
    "CustomerFullName": "auto_sys_plus_r",
    "LicenseType": 1,
    "LicensedUsersCount": 10,
    "MsTenantId": "632c26aa-0371-4402-a8ca-7cd62514dd01",
    "ActiveUserCount": 0,
    "LiveHubActiveUsersCount": 0,
    "LiveHubSimpleUsersCount": 19
  },
  {
    "UmpCustomerGuid": "8f479a63-cf48-4f36-bbcd-65267a6f06cc",
    "CustomerShortName": "two_sbc_two_cp",
    "CustomerFullName": "two_sbc_two_cp",
    "LicenseType": 5,
    "LicensedUsersCount": 15,
    "MsTenantId": "931baaa3-eb9c-4f63-bc3a-b6576d9f716d",
    "ActiveUserCount": 1,
    "LiveHubActiveUsersCount": 0,
    "LiveHubSimpleUsersCount": 0
  },
  {
    "UmpCustomerGuid": "747cbef3-5016-471f-abde-772f3aa134ad",
    "CustomerShortName": "micu_test1",
    "CustomerFullName": "micu_test1",
    "LicenseType": 0,
    "LicensedUsersCount": null,
    "MsTenantId": null,
    "ActiveUserCount": 0,
    "LiveHubActiveUsersCount": null,
    "LiveHubSimpleUsersCount": null
  },
  {
    "UmpCustomerGuid": "27aa5123-9b59-4374-bc89-838a9e536f24",
    "CustomerShortName": "auto_sys_pro_r",
    "CustomerFullName": "auto_sys_pro_r",
    "LicenseType": 2,
    "LicensedUsersCount": 30,
    "MsTenantId": "632c26aa-0371-4402-a8ca-7cd62514dd21",
    "ActiveUserCount": 0,
    "LiveHubActiveUsersCount": 0,
    "LiveHubSimpleUsersCount": 19
  },
  {
    "UmpCustomerGuid": "a521fb93-e3e4-4780-2ecb-875d98b20419",
    "CustomerShortName": "new_sept_lead",
    "CustomerFullName": "new_sept_lead",
    "LicenseType": 0,
    "LicensedUsersCount": null,
    "MsTenantId": "632c26aa-0371-4402-a8ca-7cd62544dd01",
    "ActiveUserCount": 0,
    "LiveHubActiveUsersCount": null,
    "LiveHubSimpleUsersCount": null
  },
  {
    "UmpCustomerGuid": "62a027e7-4bbb-4706-83e3-c6eb3d6055c4",
    "CustomerShortName": "new_sbc_test",
    "CustomerFullName": "new_sbc_test",
    "LicenseType": 0,
    "LicensedUsersCount": null,
    "MsTenantId": null,
    "ActiveUserCount": 0,
    "LiveHubActiveUsersCount": null,
    "LiveHubSimpleUsersCount": null
  },
  {
    "UmpCustomerGuid": "d28e1c8f-3e0b-4245-80ba-f2098d27c349",
    "CustomerShortName": "auto_sys_pro",
    "CustomerFullName": "auto_sys_pro",
    "LicenseType": 2,
    "LicensedUsersCount": 30,
    "MsTenantId": "632c26aa-0371-4402-a8ca-7cd61514dd01",
    "ActiveUserCount": 0,
    "LiveHubActiveUsersCount": 0,
    "LiveHubSimpleUsersCount": 19
  },
  {
    "UmpCustomerGuid": "06682fff-80b4-49bd-b994-f3947dd3ecaa",
    "CustomerShortName": "many_sbc_test",
    "CustomerFullName": "many_sbc_test",
    "LicenseType": 5,
    "LicensedUsersCount": 15,
    "MsTenantId": "19212e96-d56b-41d3-845c-a14fd24ddec2",
    "ActiveUserCount": 0,
    "LiveHubActiveUsersCount": 0,
    "LiveHubSimpleUsersCount": 0
  }
]

Example of a response for a request with allDetails=true (api/v3/customer?allDetails=true) in query string:

Copy 
[
  {
    "UmpCustomerGuid": "1591f338-58f8-4773-a625-0079f1565341",
    "CustomerShortName": "micu_test",
    "CustomerFullName": "micu_test",
    "LicenseType": 0,
    "LicensedUsersCount": null,
    "MsTenantId": null,
    "ActiveUserCount": 0,
    "LiveHubActiveUsersCount": null,
    "LiveHubSimpleUsersCount": null,
    "SiteLocation": [
      {
        "id": "1591f378-58f8-4773-a625-0079f1515341",
        "name": "micu_test",
        "sbcId": 2,
        "sbcDeploymentState": "Deployed",
        "sbcConfigurationType": "SipTrunk"
      }
    ]
  },
  {
    "UmpCustomerGuid": "0c8e0080-8bf3-4ae4-8b96-219977ae508f",
    "CustomerShortName": "auto_serv_ess",
    "CustomerFullName": "auto_serv_ess",
    "LicenseType": 0,
    "LicensedUsersCount": null,
    "MsTenantId": null,
    "ActiveUserCount": 0,
    "LiveHubActiveUsersCount": null,
    "LiveHubSimpleUsersCount": null,
    "SiteLocation": [
      {
        "id": "0c8e0080-8bf3-4ae4-8b96-259977ae568f",
        "name": "auto_serv_ess",
        "sbcId": 1,
        "sbcDeploymentState": "Deployed",
        "sbcConfigurationType": "SipTrunk"
      }
    ]
  },
  {
    "UmpCustomerGuid": "2373394e-7b5f-40cc-907b-29a4f70e7859",
    "CustomerShortName": "auto_sys_plus_r",
    "CustomerFullName": "auto_sys_plus_r",
    "LicenseType": 1,
    "LicensedUsersCount": 10,
    "MsTenantId": "632c26aa-0371-4402-a8ca-7cd62514dd01",
    "ActiveUserCount": 0,
    "LiveHubActiveUsersCount": 0,
    "LiveHubSimpleUsersCount": 19,
    "SiteLocation": [
      {
        "id": "2373394e-7b5f-40cc-907b-29a4f70efe59",
        "name": "auto_sys_plus_r",
        "sbcId": 1,
        "sbcDeploymentState": "Deployed",
        "sbcConfigurationType": "Byoc"
      }
    ]
  },
  {
    "UmpCustomerGuid": "8f479a63-cf48-4f36-bbcd-65267a6f06cc",
    "CustomerShortName": "two_sbc_two_cp",
    "CustomerFullName": "two_sbc_two_cp",
    "LicenseType": 5,
    "LicensedUsersCount": 15,
    "MsTenantId": "931baaa3-eb9c-4f63-bc3a-b6576d9f716d",
    "ActiveUserCount": 1,
    "LiveHubActiveUsersCount": 0,
    "LiveHubSimpleUsersCount": 0,
    "SiteLocation": [
      {
        "id": "24aa9454-77bc-433b-b73c-426e0fac8862",
        "name": "GSCIILOQQBGJR",
        "sbcId": 2,
        "sbcDeploymentState": "Deployed",
        "sbcConfigurationType": "SipTrunk"
      },
      {
        "id": "0fb000b9-a2e0-4d7a-b286-62095bddeb63",
        "name": "GSCIILOQQBORK",
        "sbcId": 1,
        "sbcDeploymentState": "Deployed",
        "sbcConfigurationType": "SipTrunk"
      }
    ]
  },
  {
    "UmpCustomerGuid": "747cbef3-5016-471f-abde-772f3aa134ad",
    "CustomerShortName": "micu_test1",
    "CustomerFullName": "micu_test1",
    "LicenseType": 0,
    "LicensedUsersCount": null,
    "MsTenantId": null,
    "ActiveUserCount": 0,
    "LiveHubActiveUsersCount": null,
    "LiveHubSimpleUsersCount": null,
    "SiteLocation": [
      {
        "id": "747cbef3-5016-481f-abde-773f3aa134ad",
        "name": "micu_test1",
        "sbcId": 2,
        "sbcDeploymentState": "Deployed",
        "sbcConfigurationType": "SipTrunk"
      }
    ]
  },
  {
    "UmpCustomerGuid": "27aa5123-9b59-4374-bc89-838a9e536f24",
    "CustomerShortName": "auto_sys_pro_r",
    "CustomerFullName": "auto_sys_pro_r",
    "LicenseType": 2,
    "LicensedUsersCount": 30,
    "MsTenantId": "632c26aa-0371-4402-a8ca-7cd62514dd21",
    "ActiveUserCount": 0,
    "LiveHubActiveUsersCount": 0,
    "LiveHubSimpleUsersCount": 19,
    "SiteLocation": [
      {
        "id": "27aa5123-9b59-4374-bc89-831a9e536f24",
        "name": "auto_sys_pro_r",
        "sbcId": 1,
        "sbcDeploymentState": "Deployed",
        "sbcConfigurationType": "SipTrunk"
      },
      {
        "id": "c273a684-867f-4ae6-8ddc-2e15adff132d",
        "name": "sip_for_delete",
        "sbcId": 1,
        "sbcDeploymentState": "Deployed",
        "sbcConfigurationType": "Byoc"
      }
    ]
  },
  {
    "UmpCustomerGuid": "a521fb93-e3e4-4780-2ecb-875d98b20419",
    "CustomerShortName": "new_sept_lead",
    "CustomerFullName": "new_sept_lead",
    "LicenseType": 0,
    "LicensedUsersCount": null,
    "MsTenantId": "632c26aa-0371-4402-a8ca-7cd62544dd01",
    "ActiveUserCount": 0,
    "LiveHubActiveUsersCount": null,
    "LiveHubSimpleUsersCount": null,
    "SiteLocation": [
      {
        "id": "2fe684b9-e426-486c-8bc3-ffdafa3921e3",
        "name": "new_sept_lead",
        "sbcId": 1,
        "sbcDeploymentState": "Deployed",
        "sbcConfigurationType": "SipTrunk"
      },
      {
        "id": "c6f0aab2-36fc-40ba-a292-f41c40f92b1e",
        "name": "reg_14_sip",
        "sbcId": 1,
        "sbcDeploymentState": "Deployed",
        "sbcConfigurationType": "Byoc"
      }
    ]
  },
  {
    "UmpCustomerGuid": "62a027e7-4bbb-4706-83e3-c6eb3d6055c4",
    "CustomerShortName": "new_sbc_test",
    "CustomerFullName": "new_sbc_test",
    "LicenseType": 0,
    "LicensedUsersCount": null,
    "MsTenantId": null,
    "ActiveUserCount": 0,
    "LiveHubActiveUsersCount": null,
    "LiveHubSimpleUsersCount": null,
    "SiteLocation": [
      {
        "id": "62a027e7-4bbb-4706-83e3-c6ebdd6055c4",
        "name": "new_sbc_test",
        "sbcId": 1,
        "sbcDeploymentState": "Deployed",
        "sbcConfigurationType": "SipTrunk"
      }
    ]
  },
  {
    "UmpCustomerGuid": "d28e1c8f-3e0b-4245-80ba-f2098d27c349",
    "CustomerShortName": "auto_sys_pro",
    "CustomerFullName": "auto_sys_pro",
    "LicenseType": 2,
    "LicensedUsersCount": 30,
    "MsTenantId": "632c26aa-0371-4402-a8ca-7cd61514dd01",
    "ActiveUserCount": 0,
    "LiveHubActiveUsersCount": 0,
    "LiveHubSimpleUsersCount": 19,
    "SiteLocation": [
      {
        "id": "d28e1c8f-3e0b-4645-80ba-f2098d77c349",
        "name": "auto_sys_pro",
        "sbcId": 1,
        "sbcDeploymentState": "Deployed",
        "sbcConfigurationType": "SipTrunk"
      }
    ]
  },
  {
    "UmpCustomerGuid": "06682fff-80b4-49bd-b994-f3947dd3ecaa",
    "CustomerShortName": "many_sbc_test",
    "CustomerFullName": "many_sbc_test",
    "LicenseType": 5,
    "LicensedUsersCount": 15,
    "MsTenantId": "19212e96-d56b-41d3-845c-a14fd24ddec2",
    "ActiveUserCount": 0,
    "LiveHubActiveUsersCount": 0,
    "LiveHubSimpleUsersCount": 0,
    "SiteLocation": [
      {
        "id": "3602a8de-b4d5-41ee-b445-a7b364b90hcf",
        "name": "GSCHJOLIPNOJW",
        "sbcId": 1,
        "sbcDeploymentState": "Deployed",
        "sbcConfigurationType": "SipTrunk"
      },
      {
        "id": "da9affdd-906b-4bbc-8e29-0efb0aaf6f38",
        "name": "GSCHJOLIPNPAK",
        "sbcId": 2,
        "sbcDeploymentState": "Deployed",
        "sbcConfigurationType": "SipTrunk"
      },
      {
        "id": "50c1d785-df66-4a5f-869c-7bc8f7e2d2ce",
        "name": "GSCHJOLIPNPPW",
        "sbcId": 1,
        "sbcDeploymentState": "Deployed",
        "sbcConfigurationType": "SipTrunk"
      },
      {
        "id": "89cfc014-cc09-4616-aa63-b370s53545fa",
        "name": "GSCHJXQLMXSWW",
        "sbcId": 1,
        "sbcDeploymentState": "Deployed",
        "sbcConfigurationType": "SipTrunk"
      },
      {
        "id": "4db710f6-8cf5-40b5-9d08-4e91d5521488",
        "name": "GSCHZFKPRWNED",
        "sbcId": 1,
        "sbcDeploymentState": "Deployed",
        "sbcConfigurationType": "SipTrunk"
      },
      {
        "id": "3306f118-f3e2-49db-806f-bfd5408f8594",
        "name": "GSCHZFZALKKYT",
        "sbcId": 1,
        "sbcDeploymentState": "Deployed",
        "sbcConfigurationType": "SipTrunk"
      },
      {
        "id": "d13de2c5-17ab-43a2-abe5-1f3fd940916c",
        "name": "GSCHZGABPHVDN",
        "sbcId": 1,
        "sbcDeploymentState": "Deployed",
        "sbcConfigurationType": "SipTrunk"
      },
      {
        "id": "0a24c186-10cc-40e3-b072-aa7e7f12dd38",
        "name": "GSCHZGGEOJMOM",
        "sbcId": 1,
        "sbcDeploymentState": "Deployed",
        "sbcConfigurationType": "SipTrunk"
      },
      {
        "id": "0872260f-9e40-4c9d-bb53-25cc83bcd2b9",
        "name": "GSCHZGGEOJNFB",
        "sbcId": 2,
        "sbcDeploymentState": "Deployed",
        "sbcConfigurationType": "SipTrunk"
      },
      {
        "id": "8269ebec-5a0b-40df-aea9-5b6590ec7f9f",
        "name": "GSCHZGGEOJONA",
        "sbcId": 1,
        "sbcDeploymentState": "Deployed",
        "sbcConfigurationType": "SipTrunk"
      },
      {
        "id": "3efb5b00-0c67-415a-8975-10b0a85a4472",
        "name": "GSCHZGGEOJORS",
        "sbcId": 1,
        "sbcDeploymentState": "Deployed",
        "sbcConfigurationType": "SipTrunk"
      }
    ]
  }
]

HTTP Responses

■ 200 OK

Parameter

Type

Description

umpCustomerGuid

string($guid)

'umpCustomerGuid' value created in the Live Platformcustomer tenant SQL database directory:

■ Operator Connect: A new OC Essentials service is created when a license is applied to the lead using Create Service from Lead Overview). If this field is null, a license has not yet been applied to the lead.
■ Direct Routing: A new Hosted Essentials service is created by Create Hosted Essentials Service.

This value is also obtained in the 'Get Task' response when the customer service is created.

CustomerShortName

string

Short name for the service, complying with validation rules:

■ The string should be 3-15 characters long
■ The following characters cannot be used: \ / : * ? " < > |audit
■ Can contain letters (lower/UPPER case), Numbers and special characters are allowed, however cannot contain the dot (.) or blank spaces.
■ Unique name per M365 Tenant

CustomerFullName

string

The full name of the service defined upon service creation.

licenseType

integer Enum:

[3, 4, 5]

[ 0, 1, 2]

One of the following values:

■ Hosted Essentials: 0
■ Hosted Essential Plus: 1
■ Hosted Pro: 2
■ OC Essential: 3
■ OC Essential Plus: 4
■ OC Pro: 5

licensedUsersCount

integer

Number of allocated licenses configured in the Onboarding of the service. This value is calculated as "Acquired Licenses" which is the license value that is allocated in the Onboarding of the service and is shown in Managing User Licenses.

msTenantID

string

Microsoft subscription Tenant ID of the customer attached to the service.

ActiveUserCount

integer

Number of Active users with used DIDs. This value is calculated as according to the license factor types described in Managing User Licenses.

siteLocation (SIP Connection)

Array including the following:

■ id: string($uuid)
■ name: string
■ sbcId: integer
■ sbcDeploymentState: string

The configured SBC used to manage calls for this SIP Connection.

id

string($uuid)

The unique id for the SIP Connection (site location). Equivalent to value 'siteGuid' created when adding the SIP Connection.

name

string

Name of the SIP Connection.

sbcId

integer

Id of the SBC device in the Live Platform SQL database (see Get SBC Devices.

sbcdeploymentState

string

Deployment state of the tenant. One of the following values:

■ Draft
■ Submitted
■ Deploying
■ Deployed
■ Error
■ ReadyForDeployment
■ ReadyForRemove
■ Removing
■ Removed

SbcConfigurationType

integer

One of the following values:

■ SIP Trunk: SIP Trunk used by the Service Provider. When this option is selected, you must select both the SBC device (see 'Region' field below) and the Service Provider Carrier SIP Trunk (see additionalProp1 parameter below).
■ BYOC: (Bring-Your-Own-Carrier) for integrating customer SIP Trunk services that are different to the SIP Trunk service used by the Service Provider. When this option is selected, you must select both the SBC device (see 'Region' field below) and the Service Provider Carrier SIP Trunk (see 'additionalProp2' parameter below).
■ IP-PBX: Service Provider IP-PBX. When this option is selected, you must select both the SBC device and the Service Provider Carrier SIP Trunk (see 'additionalProp3' parameter below).

This value is currently not supported.